freemarker模板引擎

您所在的位置：网站首页 › freemarker assign赋予变量导致合并错误 › freemarker模板引擎

freemarker模板引擎

2023-12-27 19:27| 来源: 网络整理| 查看: 265

freemarker freemarker 介绍

FreeMarker 是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言，不是像PHP那样成熟的编程语言。那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算，之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据，而在模板之外可以专注于要展示什么数据。

常用的java模板引擎还有哪些？

Jsp、Freemarker、Thymeleaf 、Velocity 等。

1.Jsp 为 Servlet 专用，不能单独进行使用。

2.Thymeleaf 为新技术，功能较为强大，但是执行的效率比较低。

3.Velocity从2010年更新完 2.0 版本后，便没有在更新。Spring Boot 官方在 1.4 版本后对此也不在支持，虽然 Velocity 在 2017 年版本得到迭代，但为时已晚。

环境搭建&&快速入门

freemarker作为springmvc一种视图格式，默认情况下SpringMVC支持freemarker视图格式。

需要创建Spring Boot+Freemarker工程用于测试模板。

创建测试工程

创建一个freemarker-demo 的测试工程专门用于freemarker的功能测试与模板的测试。

pom.xml如下

4.0.0 freemarker-demo 8 8 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-freemarker org.springframework.boot spring-boot-starter-test org.projectlombok lombok org.apache.commons commons-io 1.3.2 配置文件

配置application.yml

server: port: 8881 #服务端口 spring: application: name: freemarker-demo #指定服务名 freemarker: cache: false #关闭模板缓存，方便测试 settings: template_update_delay: 0 #检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试 suffix: .ftl #指定Freemarker模板文件的后缀名创建模型类

在freemarker的测试工程下创建模型类型用于测试

package com.heima.freemarker.entity; import lombok.Data; import java.util.Date; @Data public class Student { private String name;//姓名 private int age;//年龄 private Date birthday;//生日 private Float money;//钱包 } 创建模板

在resources下创建templates，此目录为freemarker的默认模板存放目录。

在templates下创建模板文件 01-basic.ftl ，模板中的插值表达式最终会被freemarker替换成具体的数据。

Hello World! 普通文本 String 展示： Hello ${name} 对象Student中的数据展示：姓名：${stu.name} 年龄：${stu.age} 创建controller

创建Controller类，向Map中添加name，最后返回模板文件。

package com.xuecheng.test.freemarker.controller; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.client.RestTemplate; import java.util.Map; @Controller public class HelloController { @GetMapping("/basic") public String test(Model model) { //1.纯文本形式的参数 model.addAttribute("name", "freemarker"); //2.实体类相关的参数 Student student = new Student(); student.setName("小明"); student.setAge(18); model.addAttribute("stu", student); return "01-basic"; } }

01-basic.ftl，使用插值表达式填充数据

Hello World! 普通文本 String 展示： Hello ${name} 对象Student中的数据展示：姓名：${stu.name} 年龄：${stu.age} 创建启动类 package com.heima.freemarker; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class FreemarkerDemotApplication { public static void main(String[] args) { SpringApplication.run(FreemarkerDemotApplication.class,args); } } 测试

请求：http://localhost:8881/basic

静态化测试

根据模板文件生成html文件

①：修改application.yml文件，添加以下模板存放位置的配置信息，完整配置如下：

②：在test下创建测试类

package com.heima.freemarker.test; import com.heima.freemarker.FreemarkerDemoApplication; import com.heima.freemarker.entity.Student; import freemarker.template.Configuration; import freemarker.template.Template; import freemarker.template.TemplateException; import org.junit.Test; import org.junit.runner.RunWith; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.context.junit4.SpringRunner; import java.io.FileWriter; import java.io.IOException; import java.util.*; @SpringBootTest(classes = FreemarkerDemoApplication.class) @RunWith(SpringRunner.class) public class FreemarkerTest { @Autowired private Configuration configuration; @Test public void test() throws IOException, TemplateException { //freemarker的模板对象，获取模板 Template template = configuration.getTemplate("02-list.ftl"); Map params = getData(); //合成 //第一个参数数据模型 //第二个参数输出流 template.process(params, new FileWriter("d:/list.html")); } private Map getData() { Map map = new HashMap(); //小强对象模型数据 Student stu1 = new Student(); stu1.setName("小强"); stu1.setAge(18); stu1.setMoney(1000.86f); stu1.setBirthday(new Date()); //小红对象模型数据 Student stu2 = new Student(); stu2.setName("小红"); stu2.setMoney(200.1f); stu2.setAge(19); //将两个对象模型数据存放到List集合中 List stus = new ArrayList(); stus.add(stu1); stus.add(stu2); //向map中存放List集合数据 map.put("stus", stus); //创建Map数据 HashMap stuMap = new HashMap(); stuMap.put("stu1", stu1); stuMap.put("stu2", stu2); //向map中存放Map数据 map.put("stuMap", stuMap); //返回Map return map; } } freemarker基础基础语法种类

1、注释，即，介于其之间的内容会被freemarker忽略

2、插值（Interpolation）：即 ${..} 部分,freemarker会用真实的值代替 ${..}

Hello ${name}

3、FTL指令：和HTML标记类似，名字前加#予以区分，Freemarker会解析标签中的表达式或逻辑。

FTL指令

4、文本，仅文本信息，这些不是freemarker的注释、插值、FTL指令的内容会被freemarker忽略解析，直接输出内容。

我是一个普通的文本集合指令（List和Map）

1、数据模型：

在HelloController中新增如下方法：

@GetMapping("/list") public String list(Model model){ //------------------------------------ Student stu1 = new Student(); stu1.setName("小强"); stu1.setAge(18); stu1.setMoney(1000.86f); stu1.setBirthday(new Date()); //小红对象模型数据 Student stu2 = new Student(); stu2.setName("小红"); stu2.setMoney(200.1f); stu2.setAge(19); //将两个对象模型数据存放到List集合中 List stus = new ArrayList(); stus.add(stu1); stus.add(stu2); //向model中存放List集合数据 model.addAttribute("stus",stus); //------------------------------------ //创建Map数据 HashMap stuMap = new HashMap(); stuMap.put("stu1",stu1); stuMap.put("stu2",stu2); // 3.1 向model中存放Map数据 model.addAttribute("stuMap", stuMap); return "02-list"; }

2、模板：

在templates中新增02-list.ftl文件

Hello World! 展示list中的stu数据: 序号姓名年龄钱包 map数据的展示：方式一：通过map['keyname'].property 输出stu1的学生信息：姓名：年龄：方式二：通过map.keyname.property 输出stu2的学生信息：姓名：年龄：遍历map中两个学生信息：序号姓名年龄钱包

实例代码：

Hello World! 展示list中的stu数据: 序号姓名年龄钱包 ${stu_index+1} ${stu.name} ${stu.age} ${stu.money} map数据的展示：方式一：通过map['keyname'].property 输出stu1的学生信息：姓名：${stuMap['stu1'].name} 年龄：${stuMap['stu1'].age} 方式二：通过map.keyname.property 输出stu2的学生信息：姓名：${stuMap.stu2.name} 年龄：${stuMap.stu2.age} 遍历map中两个学生信息：序号姓名年龄钱包 ${key_index} ${stuMap[key].name} ${stuMap[key].age} ${stuMap[key].money}

👆上面代码解释：

${k_index}： index：得到循环的下标，使用方法是在stu后边加"_index"，它的值是从0开始

if指令

if 指令即判断指令，是常用的FTL指令，freemarker在解析时遇到if会进行判断，条件为真则输出if中间的内容，否则跳过内容不再输出。

指令格式

1、数据模型：

使用list指令中测试数据模型，判断名称为小红的数据字体显示为红色。

2、模板：

姓名年龄钱包 ${stu.name} ${stu.age} ${stu.mondy}

实例代码：

姓名年龄钱包 ${stu_index} ${stu.name} ${stu.age} ${stu.money} ${stu_index} ${stu.name} ${stu.age} ${stu.money}

3、输出：

姓名为“小强”则字体颜色显示为红色。

运算符

1、算数运算符

FreeMarker表达式中完全支持算术运算,FreeMarker支持的算术运算符包括:

加法： + 减法： - 乘法： * 除法： / 求模 (求余)： %

模板代码

算数运算符 100+5 运算： ${100 + 5 } 100 - 5 * 5运算：${100 - 5 * 5} 5 / 2运算：${5 / 2} 12 % 10运算：${12 % 10}

除了 + 运算以外，其他的运算只能和 number 数字类型的计算。

2、比较运算符

=或者==:判断两个值是否相等. !=:判断两个值是否不等. > 或者**gt**:判断左边值是否大于右边值 >=或者gte:判断左边值是否大于等于右边值 = date2?date

Controller 的数据模型代码

@GetMapping("operation") public String testOperation(Model model) { //构建 Date 数据 Date now = new Date(); model.addAttribute("date1", now); model.addAttribute("date2", now); return "03-operation"; }

比较运算符注意

**=**和 **!=**可以用于字符串、数值和日期来比较是否相等 **=**和 **!=**两边必须是相同类型的值,否则会产生错误字符串 "x" 、 "x " 、 "X" 比较是不等的.因为FreeMarker是精确比较其它的运行符可以作用于数字和日期,但不能作用于字符串使用**gt**等字母运算符代替 > 会有更好的效果,因为 FreeMarker会把 > 解释成FTL标签的结束字符可以使用括号来避免这种情况,如: y)>

3、逻辑运算符

逻辑与:&& 逻辑或:|| 逻辑非:!

逻辑运算符只能作用于布尔值,否则将产生错误。

模板代码

逻辑运算符 (10 lt 12 )&&( 10 gt 5 ) 显示为 true false 取反为true 空值处理

1、判断某变量是否存在使用 “??”

用法为:variable??,如果该变量存在,返回true,否则返回false

例：为防止stus为空报错可以加上判断如下：

......

2、缺失变量默认值使用 “!”

使用!要以指定一个默认值，当变量为空时显示默认值

例： ${name!''}表示如果name为空显示空字符串。

如果是嵌套对象则建议使用（）括起来

例： ${(stu.bestFriend.name)!''}表示，如果stu的bestFriend的name为空默认显示空字符串。

内建函数

内建函数语法格式：变量+?+函数名称

1、某个集合的大小

${集合名?size}

2、日期格式化

显示年月日: ${today?date} 显示时分秒： ${today?time} 显示日期+时间： ${today?datetime} 自定义格式化： ${today?string("yyyy年MM月")}

3、内建函数c

model.addAttribute("point", 102920122);

point是数字型，使用${point}会显示这个数字的值，每三位使用逗号分隔。

如果不想显示为每三位分隔的数字，可以使用c函数将数字型转成字符串输出

${point?c}

4、将json字符串转成对象

一个例子：

其中用到了 assign标签，assign的作用是定义一个变量。

开户行：${data.bank} 账号：${data.account}

模板代码：

inner Function 获得集合大小集合大小：获得日期显示年月日: 显示时分秒：显示日期+时间：自定义格式化：内建函数C 没有C函数显示的数值：有C函数显示的数值：声明变量assign

内建函数模板页面：

inner Function 获得集合大小集合大小：${stus?size} 获得日期显示年月日: ${today?date} 显示时分秒：${today?time} 显示日期+时间：${today?datetime} 自定义格式化： ${today?string("yyyy年MM月")} 内建函数C 没有C函数显示的数值：${point} 有C函数显示的数值：${point?c} 声明变量assign 开户行：${data.bank} 账号：${data.account}

内建函数Controller数据模型：

@GetMapping("innerFunc") public String testInnerFunc(Model model) { //1.1 小强对象模型数据 Student stu1 = new Student(); stu1.setName("小强"); stu1.setAge(18); stu1.setMoney(1000.86f); stu1.setBirthday(new Date()); //1.2 小红对象模型数据 Student stu2 = new Student(); stu2.setName("小红"); stu2.setMoney(200.1f); stu2.setAge(19); //1.3 将两个对象模型数据存放到List集合中 List stus = new ArrayList(); stus.add(stu1); stus.add(stu2); model.addAttribute("stus", stus); // 2.1 添加日期 Date date = new Date(); model.addAttribute("today", date); // 3.1 添加数值 model.addAttribute("point", 102920122); return "04-innerFunc"; }

【本文地址】

公司简介

联系我们